# 自定义触发器接入文档
调用方法请参见 Open API (opens new window)文档中的调用方法描述。
# 创建自定义触发任务
在自定义触发器的触发规则中创建触发场景,并配置唯一的场景 ID,且选择该触发任务的触发主体 ID 类型。
Tip:此处满足触发规则的 场景 ID 和触发的主体 ID 需要与您服务端的配置一致才能成功触发。
# 调用触发接口
# 2.1 接口URL
open/hermes/custom/trigger?token=xxx&projectId=11
# 2.2 请求方式
POST
# 2.3 Content-Type
application/json
# 2.4 请求 Query 参数
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
eventuuid | xxx | String | 是 | 事件唯一id |
projectId | 11 | int | 是 | 项目id |
sceneId | String | 是 | 场景id | |
entityId | long | 是 | 场景中的主体id类型的值:accountId/distinctId | |
eventTime | long | 是 | 事件时间 | |
eventTimezone | double | 建议是,可不填 | 事件时间-时区,默认服务器时区 |
# 2.5 成功响应示例
{
"return_code": 0,
"return_message": "success"
}
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
return_code | 0 | Integer | 返回码 |
return_message | success | String | 返回信息 |
# 2.6 错误响应示例
{
"return_code": -1008,
"return_message": "参数错误"
}
# 2.7 错误码说明
错误码 | 错误说明 |
---|---|
-1008 | 参数错误(hermes.open.service.error.eventtime.not_valid) |
-1006 | token鉴权失败(error.auth.authority_forbidden.token) |
-1005 | 操作频繁/接口限流(error.op.too_many_open_api_request) |
-1023 | 场景/任务不存在或已被删除(error.op.not_existed_with_name) |
-1011 | 该任务状态不是进行中(hermes.open.service.error.task.status_not_working) |
-1009 | 用户不存在(hermes.open.service.error.user_id.not_exit) |
-1108 | 事件重复(hermes.open.service.error.task.event_id.repeat) |
-1004 | 系统异常(hermes.service.error.system.common) |